<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Class Swift_FileSpool | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Swift.html">Swift</a></li>
				<li><a href="class-Swift_ConfigurableSpool.html">Swift_ConfigurableSpool</a></li>
				<li><a href="class-Swift_DependencyContainer.html">Swift_DependencyContainer</a></li>
				<li class="active"><a href="class-Swift_FileSpool.html">Swift_FileSpool</a></li>
				<li><a href="class-Swift_Mailer.html">Swift_Mailer</a></li>
				<li><a href="class-Swift_NullTransport.html">Swift_NullTransport</a></li>
				<li><a href="class-Swift_Preferences.html">Swift_Preferences</a></li>
				<li><a href="class-Swift_SpoolTransport.html">Swift_SpoolTransport</a></li>
				<li><a href="class-Swift_StreamFilters_ByteArrayReplacementFilter.html">Swift_StreamFilters_ByteArrayReplacementFilter</a></li>
				<li><a href="class-Swift_StreamFilters_StringReplacementFilter.html">Swift_StreamFilters_StringReplacementFilter</a></li>
				<li><a href="class-Swift_StreamFilters_StringReplacementFilterFactory.html">Swift_StreamFilters_StringReplacementFilterFactory</a></li>
				<li><a href="class-Swift_Transport_NullTransport.html">Swift_Transport_NullTransport</a></li>
				<li><a href="class-Swift_Transport_SpoolTransport.html">Swift_Transport_SpoolTransport</a></li>
				<li><a href="class-Swift_Validate.html">Swift_Validate</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li><a href="class-Swift_Filterable.html">Swift_Filterable</a></li>
				<li><a href="class-Swift_ReplacementFilterFactory.html">Swift_ReplacementFilterFactory</a></li>
				<li><a href="class-Swift_Spool.html">Swift_Spool</a></li>
				<li><a href="class-Swift_StreamFilter.html">Swift_StreamFilter</a></li>
			</ul>


			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-Swift_DependencyException.html">Swift_DependencyException</a></li>
				<li><a href="class-Swift_IoException.html">Swift_IoException</a></li>
				<li><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></li>
				<li><a href="class-Swift_SwiftException.html">Swift_SwiftException</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.html" title="Summary of Swift"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Swift_FileSpool</h1>


	<div class="description">
	
<p>Stores Messages on the filesystem.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
			<a href="class-Swift_ConfigurableSpool.html"><span>Swift_ConfigurableSpool</span></a>
			
			 implements 
				<a href="class-Swift_Spool.html"><span>Swift_Spool</span></a>
			
			
		</dd>
		<dd style="padding-left:30px">
			<img src="resources/inherit.png" alt="Extended by" />
<b><span>Swift_FileSpool</span></b>			
			
			
		</dd>
	</dl>








	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a><br />

				<b>Author:</b>
				Fabien Potencier<br />
				<b>Author:</b>
				Xavier De Cock &lt;<a
href="mailto:xdecock&#64;gmail.com">xdecock&#64;<!---->gmail.com</a>&gt;<br />
		<b>Located at</b> <a href="source-class-Swift_FileSpool.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/FileSpool.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Swift_FileSpool.html#30" title="Go to source code">__construct</a>( <span>string <var>$path</var></span> )</code>

		<div class="description short">
			
<p>Create a new FileSpool.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Create a new FileSpool.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$path</var></dt>
					<dd><code>string</code></dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_IoException.html">Swift_IoException</a></code></code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="isStarted" id="_isStarted">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_isStarted">#</a>
		<code><a href="source-class-Swift_FileSpool.html#48" title="Go to source code">isStarted</a>( )</code>

		<div class="description short">
			
<p>Tests if this Spool mechanism has started.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Tests if this Spool mechanism has started.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>




				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Spool.html#_">Swift_Spool::isStarted</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="start" id="_start">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_start">#</a>
		<code><a href="source-class-Swift_FileSpool.html#59" title="Go to source code">start</a>( )</code>

		<div class="description short">
			
<p>Starts this Spool mechanism.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Starts this Spool mechanism.</p>








				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Spool.html#_">Swift_Spool::start</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="stop" id="_stop">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_stop">#</a>
		<code><a href="source-class-Swift_FileSpool.html#67" title="Go to source code">stop</a>( )</code>

		<div class="description short">
			
<p>Stops this Spool mechanism.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Stops this Spool mechanism.</p>








				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Spool.html#_">Swift_Spool::stop</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="setRetryLimit" id="_setRetryLimit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setRetryLimit">#</a>
		<code><a href="source-class-Swift_FileSpool.html#75" title="Go to source code">setRetryLimit</a>( <span>integer <var>$limit</var></span> )</code>

		<div class="description short">
			
<p>Allow to manage the enqueuing retry limit. Default, is ten and allows over
64<sup>20</sup> different fileNames</p>

		</div>

		<div class="description detailed hidden">
			
<p>Allow to manage the enqueuing retry limit. Default, is ten and allows over
64<sup>20</sup> different fileNames</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$limit</var></dt>
					<dd><code>integer</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="queueMessage" id="_queueMessage">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_queueMessage">#</a>
		<code><a href="source-class-Swift_FileSpool.html#87" title="Go to source code">queueMessage</a>( <span><code><a href="class-Swift_Mime_Message.html">Swift_Mime_Message</a></code> <var>$message</var></span> )</code>

		<div class="description short">
			
<p>Queues a message.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Queues a message.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$message</var></dt>
					<dd><code><code><a href="class-Swift_Mime_Message.html">Swift_Mime_Message</a></code></code><br> The message to store</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_IoException.html">Swift_IoException</a></code></code><br />
				</div>



				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Spool.html#_">Swift_Spool::queueMessage</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="recover" id="_recover">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_recover">#</a>
		<code><a href="source-class-Swift_FileSpool.html#119" title="Go to source code">recover</a>( <span>integer <var>$timeout</var> = <span class="php-num">900</span></span> )</code>

		<div class="description short">
			
<p>Execute a recovery if for anyreason a process is sending for too long</p>

		</div>

		<div class="description detailed hidden">
			
<p>Execute a recovery if for anyreason a process is sending for too long</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$timeout</var></dt>
					<dd><code>integer</code><br> in second Defaults is for very slow smtp responses</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="flushQueue" id="_flushQueue">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_flushQueue">#</a>
		<code><a href="source-class-Swift_FileSpool.html#139" title="Go to source code">flushQueue</a>( <span><code><a href="class-Swift_Transport.html">Swift_Transport</a></code> <var>$transport</var></span>, <span>string[] <var>&amp; $failedRecipients</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Sends messages using the given transport instance.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Sends messages using the given transport instance.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$transport</var></dt>
					<dd><code><code><a href="class-Swift_Transport.html">Swift_Transport</a></code></code><br> A transport instance</dd>
					<dt><var>$failedRecipients</var></dt>
					<dd><code>string[]</code><br>&amp;$failedRecipients An array of failures by-reference</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br>The number of sent emails<br />
				</div>




				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Spool.html#_">Swift_Spool::flushQueue</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="getRandomString" id="_getRandomString">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getRandomString">#</a>
		<code><a href="source-class-Swift_FileSpool.html#190" title="Go to source code">getRandomString</a>( <span>integer <var>$count</var></span> )</code>

		<div class="description short">
			
<p>Returns a random string needed to generate a fileName for the queue.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns a random string needed to generate a fileName for the queue.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$count</var></dt>
					<dd><code>integer</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	</table>

	<table class="summary inherited">
	<caption>Methods inherited from <a href="class-Swift_ConfigurableSpool.html#methods">Swift_ConfigurableSpool</a></caption>
	<tr>
		<td><code>
			<a href="class-Swift_ConfigurableSpool.html#_">getMessageLimit()</a>, 
			<a href="class-Swift_ConfigurableSpool.html#_">getTimeLimit()</a>, 
			<a href="class-Swift_ConfigurableSpool.html#_">setMessageLimit()</a>, 
			<a href="class-Swift_ConfigurableSpool.html#_">setTimeLimit()</a>
		</code></td>
	</tr>
	</table>









</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
